Skip to main content
Version: 1.0.16

ALTER AGGREGATE

ALTER AGGREGATE — Change the Definition of an Aggregate Function

Synopsis

ALTER AGGREGATE name ( aggregate_signature ) RENAME TO new_name

ALTER AGGREGATE name ( aggregate_signature )

OWNER TO { new_owner | CURRENT_USER | SESSION_USER }

ALTER AGGREGATE name ( aggregate_signature ) SET SCHEMA new_schema

where aggregate_signature is:

[ argmode ] [ argname ] argtype [ , ... ]

[ [ argmode ] [ argname ] argtype [ , ... ] ] ORDER BY [ argmode ] [ argname ] argtype [ , ... ]

Description

ALTER AGGREGATE changes the definition of an aggregate function.

To use ALTER AGGREGATE, you must own the aggregate function. To change the schema of an aggregate function, you must also have CREATE privilege on the new schema. To change the owner, you must also be a direct or indirect member of the new owning role, and that role must have CREATE privilege on the aggregate function's schema (these restrictions enforce that changing the owner cannot do anything you couldn't do by dropping and recreating the aggregate function. However, a superuser can change ownership of any aggregate function).

Parameters

name

The name (optionally schema-qualified) of an existing aggregate function.

argmode

The mode of an argument: IN or VARIADIC. If omitted, the default is IN.

argname

The name of an argument. Note that ALTER AGGREGATE does not actually care about argument names, since only the argument data types are needed to determine the aggregate function's identity.

argtype

The input data type on which the aggregate function operates. To reference a zero-argument aggregate function, write * in place of the argument specification list. To reference an ordered-set aggregate function, write ORDER BY between the direct argument specification and the aggregate argument specification.

new_name

The new name of the aggregate function.

new_owner

The new owner of the aggregate function.

new_schema

The new schema for the aggregate function.

Notes

The recommended syntax for referencing an ordered-set aggregate is to write ORDER BY between the direct argument specification and the aggregate argument specification, in the same style as in CREATE AGGREGATE. However, it is also acceptable to omit ORDER BY and simply put the direct and aggregate argument specifications into a single list. In this abbreviated form, if both the direct and aggregate argument lists use VARIADIC "any", simply write VARIADIC "any" only once.

Examples

# To rename the aggregate function myavg for type integer to my_average:

ALTER AGGREGATE myavg(integer) RENAME TO my_average;

# To change the owner of the aggregate function myavg for type integer to joe:

ALTER AGGREGATE myavg(integer) OWNER TO joe;

# To move the ordered-set aggregate mypercentile with direct argument type float8 and aggregate argument type integer to schema myschema:

ALTER AGGREGATE mypercentile(float8 ORDER BY integer) SET SCHEMA myschema;

# This also works:

ALTER AGGREGATE mypercentile(float8, integer) SET SCHEMA myschema;

See Also

CREATE AGGREGATE, DROP AGGREGATE